API

System APIs

POST system/export-apis

Creates a new export API

HTTP method POST
URI https://api.rambase.net/system/export-apis
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 4074, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ExportAPI>
2
     <Uri
Uri

Required/mandatory field

Uri of API

>{String}</Uri>
3
     <Context
Context

Required/mandatory field

Usage context of the export API

Applicable domain values can be found here

>{Integer}</Context>
4
</ExportAPI>
1
{
2
     "exportAPI": {
3
          "uri
Uri

Required/mandatory field

Uri of API

": "{String}",
4
          "context
Context

Required/mandatory field

Usage context of the export API

Applicable domain values can be found here

": "{Integer}"
5
     }
6
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ExportAPI>
2
     <ExportAPIId
ExportAPIId

Export API identifier

>{Integer}</ExportAPIId>
3
     <Status
Status

Status of export API

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Uri
Uri

Uri of API

>{String}</Uri>
6
     <Context
Context

Usage context of the export API

Possible domain values can be found here

>{Integer}</Context>
7
</ExportAPI>
1
{
2
     "exportAPI": {
3
          "exportAPIId
ExportAPIId

Export API identifier

": "{Integer}",
4
          "status
Status

Status of export API

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "uri
Uri

Uri of API

": "{String}",
7
          "context
Context

Usage context of the export API

Possible domain values can be found here

": "{Integer}"
8
     }
9
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 105132 HTTP 400 Export API already exists